Skip to content

chore: add high level docs#27

Closed
zachsmith1 wants to merge 2 commits intomainfrom
chore/docs
Closed

chore: add high level docs#27
zachsmith1 wants to merge 2 commits intomainfrom
chore/docs

Conversation

@zachsmith1
Copy link
Contributor

Connector and Envoy Integration Design:

  • Introduced a new design document (docs/connector-envoy-design.md) detailing how Connector and ConnectorAdvertisement resources are used to route traffic through Envoy and an iroh sidecar, including the data path, sidecar responsibilities, route metadata contract, and validation rules.

End-to-End Flow Documentation:

  • Added an end-to-end flow doc (docs/connector-e2e-flow.md) outlining the tunnel lifecycle, responsibilities of each component (Device Agent, Control Plane, NSO, Envoy), and the data exchanged at each step.

NSO Work Plan and Implementation Steps:

  • Added a work plan (docs/nso-connector-work.md) specifying new controllers, reconciliation logic, validation, Gateway API programming, and required API updates to enable connector-aware routing in NSO. Also includes an MVP checklist for implementation.

Copy link
Contributor

@scotwells scotwells left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Matches my understanding of how things are things are supposed to work. This should be in the enhancements repo though since it spans multiple software components.

@zachsmith1
Copy link
Contributor Author

Opened this enhancement to cover this implementation: datum-cloud/enhancements#556

@joshlreese I should have covered your initial questions/comments but feel free to start threads there.

@zachsmith1 zachsmith1 closed this Jan 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants